home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpfloatingsel.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  7.9 KB  |  200 lines
  1. <refentry id="libgimp-gimpfloatingsel" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpfloatingsel</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpfloatingsel</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-floating-sel-remove">gimp_floating_sel_remove</link>        (<link linkend="gint32">gint32</link> floating_sel_ID);
  18. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-floating-sel-anchor">gimp_floating_sel_anchor</link>        (<link linkend="gint32">gint32</link> floating_sel_ID);
  19. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-floating-sel-to-layer">gimp_floating_sel_to_layer</link>      (<link linkend="gint32">gint32</link> floating_sel_ID);
  20. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-floating-sel-attach">gimp_floating_sel_attach</link>        (<link linkend="gint32">gint32</link> layer_ID,
  21.                                              <link linkend="gint32">gint32</link> drawable_ID);
  22. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-floating-sel-rigor">gimp_floating_sel_rigor</link>         (<link linkend="gint32">gint32</link> floating_sel_ID,
  23.                                              <link linkend="gboolean">gboolean</link> undo);
  24. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-floating-sel-relax">gimp_floating_sel_relax</link>         (<link linkend="gint32">gint32</link> floating_sel_ID,
  25.                                              <link linkend="gboolean">gboolean</link> undo);
  26. </synopsis>
  27. </refsynopsisdiv>
  28.  
  29.  
  30.  
  31.  
  32.  
  33. <refsect1>
  34. <title>Description</title>
  35. <para>
  36.  
  37. </para>
  38. </refsect1>
  39.  
  40. <refsect1>
  41. <title>Details</title>
  42. <refsect2>
  43. <title><anchor id="gimp-floating-sel-remove">gimp_floating_sel_remove ()</title>
  44. <programlisting><link linkend="gboolean">gboolean</link>    gimp_floating_sel_remove        (<link linkend="gint32">gint32</link> floating_sel_ID);</programlisting>
  45. <para>
  46. Remove the specified floating selection from its associated
  47. drawable.
  48. </para>
  49. <para>
  50. This procedure removes the floating selection completely, without
  51. any side effects. The associated drawable is then set to active.</para>
  52. <para>
  53.  
  54. </para><informaltable pgwide=1 frame="none" role="params">
  55. <tgroup cols="2">
  56. <colspec colwidth="2*">
  57. <colspec colwidth="8*">
  58. <tbody>
  59. <row><entry align="right"><parameter>floating_sel_ID</parameter> :</entry>
  60. <entry> The floating selection.
  61. </entry></row>
  62. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  63. </entry></row>
  64. </tbody></tgroup></informaltable></refsect2>
  65. <refsect2>
  66. <title><anchor id="gimp-floating-sel-anchor">gimp_floating_sel_anchor ()</title>
  67. <programlisting><link linkend="gboolean">gboolean</link>    gimp_floating_sel_anchor        (<link linkend="gint32">gint32</link> floating_sel_ID);</programlisting>
  68. <para>
  69. Anchor the specified floating selection to its associated drawable.
  70. </para>
  71. <para>
  72. This procedure anchors the floating selection to its associated
  73. drawable. This is similar to merging with a merge type of
  74. ClipToBottomLayer. The floating selection layer is no longer valid
  75. after this operation.</para>
  76. <para>
  77.  
  78. </para><informaltable pgwide=1 frame="none" role="params">
  79. <tgroup cols="2">
  80. <colspec colwidth="2*">
  81. <colspec colwidth="8*">
  82. <tbody>
  83. <row><entry align="right"><parameter>floating_sel_ID</parameter> :</entry>
  84. <entry> The floating selection.
  85. </entry></row>
  86. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  87. </entry></row>
  88. </tbody></tgroup></informaltable></refsect2>
  89. <refsect2>
  90. <title><anchor id="gimp-floating-sel-to-layer">gimp_floating_sel_to_layer ()</title>
  91. <programlisting><link linkend="gboolean">gboolean</link>    gimp_floating_sel_to_layer      (<link linkend="gint32">gint32</link> floating_sel_ID);</programlisting>
  92. <para>
  93. Transforms the specified floating selection into a layer.
  94. </para>
  95. <para>
  96. This procedure transforms the specified floating selection into a
  97. layer with the same offsets and extents. The composited image will
  98. look precisely the same, but the floating selection layer will no
  99. longer be clipped to the extents of the drawable it was attached to.
  100. The floating selection will become the active layer. This procedure
  101. will not work if the floating selection has a different base type
  102. from the underlying image. This might be the case if the floating
  103. selection is above an auxillary channel or a layer mask.</para>
  104. <para>
  105.  
  106. </para><informaltable pgwide=1 frame="none" role="params">
  107. <tgroup cols="2">
  108. <colspec colwidth="2*">
  109. <colspec colwidth="8*">
  110. <tbody>
  111. <row><entry align="right"><parameter>floating_sel_ID</parameter> :</entry>
  112. <entry> The floating selection.
  113. </entry></row>
  114. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  115. </entry></row>
  116. </tbody></tgroup></informaltable></refsect2>
  117. <refsect2>
  118. <title><anchor id="gimp-floating-sel-attach">gimp_floating_sel_attach ()</title>
  119. <programlisting><link linkend="gboolean">gboolean</link>    gimp_floating_sel_attach        (<link linkend="gint32">gint32</link> layer_ID,
  120.                                              <link linkend="gint32">gint32</link> drawable_ID);</programlisting>
  121. <para>
  122. Attach the specified layer as floating to the specified drawable.
  123. </para>
  124. <para>
  125. This procedure attaches the layer as floating selection to the
  126. drawable.</para>
  127. <para>
  128.  
  129. </para><informaltable pgwide=1 frame="none" role="params">
  130. <tgroup cols="2">
  131. <colspec colwidth="2*">
  132. <colspec colwidth="8*">
  133. <tbody>
  134. <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
  135. <entry> The layer (is attached as floating selection).
  136. </entry></row>
  137. <row><entry align="right"><parameter>drawable_ID</parameter> :</entry>
  138. <entry> The drawable (where to attach the floating selection).
  139. </entry></row>
  140. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  141. </entry></row>
  142. </tbody></tgroup></informaltable></refsect2>
  143. <refsect2>
  144. <title><anchor id="gimp-floating-sel-rigor">gimp_floating_sel_rigor ()</title>
  145. <programlisting><link linkend="gboolean">gboolean</link>    gimp_floating_sel_rigor         (<link linkend="gint32">gint32</link> floating_sel_ID,
  146.                                              <link linkend="gboolean">gboolean</link> undo);</programlisting>
  147. <para>
  148. Rigor the floating selection.
  149. </para>
  150. <para>
  151. This procedure rigors the floating selection.</para>
  152. <para>
  153.  
  154. </para><informaltable pgwide=1 frame="none" role="params">
  155. <tgroup cols="2">
  156. <colspec colwidth="2*">
  157. <colspec colwidth="8*">
  158. <tbody>
  159. <row><entry align="right"><parameter>floating_sel_ID</parameter> :</entry>
  160. <entry> The floating selection.
  161. </entry></row>
  162. <row><entry align="right"><parameter>undo</parameter> :</entry>
  163. <entry> %<literal>desc</literal>%%.
  164. </entry></row>
  165. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  166. </entry></row>
  167. </tbody></tgroup></informaltable></refsect2>
  168. <refsect2>
  169. <title><anchor id="gimp-floating-sel-relax">gimp_floating_sel_relax ()</title>
  170. <programlisting><link linkend="gboolean">gboolean</link>    gimp_floating_sel_relax         (<link linkend="gint32">gint32</link> floating_sel_ID,
  171.                                              <link linkend="gboolean">gboolean</link> undo);</programlisting>
  172. <para>
  173. Relax the floating selection.
  174. </para>
  175. <para>
  176. This procedure relaxes the floating selection.</para>
  177. <para>
  178.  
  179. </para><informaltable pgwide=1 frame="none" role="params">
  180. <tgroup cols="2">
  181. <colspec colwidth="2*">
  182. <colspec colwidth="8*">
  183. <tbody>
  184. <row><entry align="right"><parameter>floating_sel_ID</parameter> :</entry>
  185. <entry> The floating selection.
  186. </entry></row>
  187. <row><entry align="right"><parameter>undo</parameter> :</entry>
  188. <entry> %<literal>desc</literal>%%.
  189. </entry></row>
  190. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  191. </entry></row>
  192. </tbody></tgroup></informaltable></refsect2>
  193.  
  194. </refsect1>
  195.  
  196.  
  197.  
  198.  
  199. </refentry>
  200.